
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>stratified_plume_model.err_check &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="stratified_plume_model.plot_state_space" href="stratified_plume_model.plot_state_space.html" />
    <link rel="prev" title="stratified_plume_model.outer_main" href="stratified_plume_model.outer_main.html" />
   
  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="stratified-plume-model-err-check">
<h1>stratified_plume_model.err_check<a class="headerlink" href="#stratified-plume-model-err-check" title="Permalink to this headline">¶</a></h1>
<dl class="function">
<dt id="stratified_plume_model.err_check">
<code class="sig-prename descclassname">stratified_plume_model.</code><code class="sig-name descname">err_check</code><span class="sig-paren">(</span><em class="sig-param">zi</em>, <em class="sig-param">yi</em>, <em class="sig-param">zo</em>, <em class="sig-param">yo</em>, <em class="sig-param">zi_old</em>, <em class="sig-param">yi_old</em>, <em class="sig-param">zo_old</em>, <em class="sig-param">yo_old</em>, <em class="sig-param">yi_local</em>, <em class="sig-param">yo_local</em>, <em class="sig-param">particles</em>, <em class="sig-param">profile</em>, <em class="sig-param">p</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/stratified_plume_model.html#err_check"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#stratified_plume_model.err_check" title="Permalink to this definition">¶</a></dt>
<dd><p>Computes the error between two solutions of the state space.</p>
<p>Compares two state space solutions and returns the maximum relative error
among a suite of error tests that include state space variable magnitudes
as well as geometric scales (intrusion and peel depths, etc.).</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>zi</strong><span class="classifier">ndarray</span></dt><dd><p>Vector of depths for the inner plume solution (m).</p>
</dd>
<dt><strong>yi</strong><span class="classifier">ndarray</span></dt><dd><p>Matrix of inner plume state space variables, each row corresponding
to a depth in <cite>zi</cite>.</p>
</dd>
<dt><strong>zo</strong><span class="classifier">ndarray</span></dt><dd><p>Vector of depths for the outer plume solution (m).</p>
</dd>
<dt><strong>yo</strong><span class="classifier">ndarray</span></dt><dd><p>Matrix of outer plume state space variables, each row corresponding
to a depth in <cite>zo</cite>.</p>
</dd>
<dt><strong>zi_old</strong><span class="classifier">ndarray</span></dt><dd><p>Values of <cite>zi</cite> for the previous iteration.</p>
</dd>
<dt><strong>yi_old</strong><span class="classifier">ndarray</span></dt><dd><p>Values of <cite>yi</cite> for the previous iteration.</p>
</dd>
<dt><strong>zo_old</strong><span class="classifier">ndarray</span></dt><dd><p>Values of <cite>zo</cite> for the previous iteration.</p>
</dd>
<dt><strong>yo_old</strong><span class="classifier">ndarray</span></dt><dd><p>Values of <cite>yo</cite> for the previous iteration.</p>
</dd>
<dt><strong>yi_local</strong><span class="classifier"><cite>InnerPlume</cite> object</span></dt><dd><p>Object containing the inner plume state space and methods to extract
the state space variables</p>
</dd>
<dt><strong>yo_local</strong><span class="classifier"><cite>OuterPlume</cite> object</span></dt><dd><p>Object containing the outer plume state space and methods to extract
the state space variables</p>
</dd>
<dt><strong>particles</strong><span class="classifier">list of <cite>dispersed_phases.PlumeParticle</cite> objects</span></dt><dd><p>List of <cite>dispersed_phases.PlumeParticle</cite> objects containing the
dispersed phase local conditions and behavior.</p>
</dd>
<dt><strong>profile</strong><span class="classifier"><cite>ambient.Profile</cite> object</span></dt><dd><p>The ambient CTD object used by the simulation.</p>
</dd>
<dt><strong>p</strong><span class="classifier"><cite>ModelParams</cite> object</span></dt><dd><p>Object containing the fixed model parameters for the stratified
plume model.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt><strong>ea</strong><span class="classifier">float</span></dt><dd><p>Maximum value of the relative error for the given error tests.</p>
</dd>
</dl>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The error statistics are computed for the peel heights, trap heights,
intrusion layer fluxes, inner plume flux at the base of each intrusion
layer, the maximum flow rates, and maximum momentum fluxes, and the
total height of the plume.  The largest absolute relative error is
returned.</p>
</dd></dl>

</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../user_manual.html">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../../index.html">Documentation overview</a><ul>
  <li><a href="../../user_manual.html">TAMOC User Manual</a><ul>
  <li><a href="../../modules/spm.html">Overview of Stratified Plume Model Module</a><ul>
      <li>Previous: <a href="stratified_plume_model.outer_main.html" title="previous chapter">stratified_plume_model.outer_main</a></li>
      <li>Next: <a href="stratified_plume_model.plot_state_space.html" title="next chapter">stratified_plume_model.plot_state_space</a></li>
  </ul></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../../_sources/autodoc/spm/stratified_plume_model.err_check.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>